﻿<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>
  
  <head>
    <meta charset="utf-8">
    <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
    <title>Class VariablePresenceRule
   </title>
    <meta name="viewport" content="width=device-width">
    <meta name="title" content="Class VariablePresenceRule
   ">
    <meta name="generator" content="docfx 2.52.0.0">
    
    <link rel="shortcut icon" href="../api/images/favicon.ico">
    <link rel="stylesheet" href="../styles/docfx.vendor.css">
    <link rel="stylesheet" href="../styles/docfx.css">
    <link rel="stylesheet" href="../styles/main.css">
    <link href="https://fonts.googleapis.com/css?family=Roboto" rel="stylesheet"> 
    <meta property="docfx:navrel" content="../toc.html">
    <meta property="docfx:tocrel" content="toc.html">
    <script type="text/javascript" async="" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/MathJax.js?config=TeX-MML-AM_CHTML"></script>
    
    
    
  </head>  <body data-spy="scroll" data-target="#affix" data-offset="120">
    <div id="wrapper">
      <header>
        
        <nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
          <div class="container">
            <div class="navbar-header">
              <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
                <span class="sr-only">Toggle navigation</span>
                <span class="icon-bar"></span>
                <span class="icon-bar"></span>
                <span class="icon-bar"></span>
              </button>
              
              <a class="navbar-brand" href="../index.html">
                <img id="logo" class="svg" src="../api/images/favicon.svg" alt="">
              </a>
            </div>
            <div class="collapse navbar-collapse" id="navbar">
              <form class="navbar-form navbar-right" role="search" id="search">
                <div class="form-group">
                  <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
                </div>
              </form>
            </div>
          </div>
        </nav>
        
        <div class="subnav navbar navbar-default">
          <div class="container hide-when-search" id="breadcrumb">
            <ul class="breadcrumb">
              <li></li>
            </ul>
          </div>
        </div>
      </header>
      <div role="main" class="container body-content hide-when-search">
        
        <div class="sidenav hide-when-search">
          <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
          <div class="sidetoggle collapse" id="sidetoggle">
            <div id="sidetoc"></div>
          </div>
        </div>
        <div class="article row grid-right">
          <div class="col-md-10">
            <article class="content wrap" id="_content" data-uid="SpiceSharp.Validation.VariablePresenceRule">
  
  
  <h1 id="SpiceSharp_Validation_VariablePresenceRule" data-uid="SpiceSharp.Validation.VariablePresenceRule" class="text-break">Class VariablePresenceRule
  </h1>
  <div class="markdown level0 summary"><p>An <a class="xref" href="SpiceSharp.Validation.IConductiveRule.html">IConductiveRule</a> that will check for the presence of a specific variable.</p>
</div>
  <div class="markdown level0 conceptual"></div>
  <div class="inheritance">
    <h5>Inheritance</h5>
    <div class="level0"><span class="xref">System.Object</span></div>
    <div class="level1"><span class="xref">VariablePresenceRule</span></div>
  </div>
  <div classs="implements">
    <h5>Implements</h5>
    <div><a class="xref" href="SpiceSharp.Validation.IConductiveRule.html">IConductiveRule</a></div>
    <div><a class="xref" href="SpiceSharp.Validation.IRule.html">IRule</a></div>
  </div>
  <div class="inheritedMembers">
    <h5>Inherited Members</h5>
    <div>
      <span class="xref">System.Object.ToString()</span>
    </div>
    <div>
      <span class="xref">System.Object.Equals(System.Object)</span>
    </div>
    <div>
      <span class="xref">System.Object.Equals(System.Object, System.Object)</span>
    </div>
    <div>
      <span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
    </div>
    <div>
      <span class="xref">System.Object.GetHashCode()</span>
    </div>
    <div>
      <span class="xref">System.Object.GetType()</span>
    </div>
    <div>
      <span class="xref">System.Object.MemberwiseClone()</span>
    </div>
  </div>
  <h6><strong>Namespace</strong>: <a class="xref" href="SpiceSharp.Validation.html">SpiceSharp.Validation</a></h6>
  <h6><strong>Assembly</strong>: SpiceSharp.dll</h6>
  <h5 id="SpiceSharp_Validation_VariablePresenceRule_syntax">Syntax</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public class VariablePresenceRule : IConductiveRule, IRule</code></pre>
  </div>
  <h3 id="constructors">Constructors
  </h3>
  <a id="SpiceSharp_Validation_VariablePresenceRule__ctor_" data-uid="SpiceSharp.Validation.VariablePresenceRule.#ctor*"></a>
  <h4 id="SpiceSharp_Validation_VariablePresenceRule__ctor_SpiceSharp_Simulations_IVariable_" data-uid="SpiceSharp.Validation.VariablePresenceRule.#ctor(SpiceSharp.Simulations.IVariable)">VariablePresenceRule(IVariable)</h4>
  <div class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="SpiceSharp.Validation.VariablePresenceRule.html">VariablePresenceRule</a> class.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="decalaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public VariablePresenceRule(IVariable search)</code></pre>
  </div>
  <h5 class="parameters">Parameters</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Name</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><a class="xref" href="SpiceSharp.Simulations.IVariable.html">IVariable</a></td>
        <td><span class="parametername">search</span></td>
        <td><p>The varibale that needs to be present.</p>
</td>
      </tr>
    </tbody>
  </table>
  <h3 id="properties">Properties
  </h3>
  <a id="SpiceSharp_Validation_VariablePresenceRule_ViolationCount_" data-uid="SpiceSharp.Validation.VariablePresenceRule.ViolationCount*"></a>
  <h4 id="SpiceSharp_Validation_VariablePresenceRule_ViolationCount" data-uid="SpiceSharp.Validation.VariablePresenceRule.ViolationCount">ViolationCount</h4>
  <div class="markdown level1 summary"><p>Gets the number of violations of this rule.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="decalaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public int ViolationCount { get; }</code></pre>
  </div>
  <h5 class="propertyValue">Property Value</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><span class="xref">System.Int32</span></td>
        <td><p>The violation count.</p>
</td>
      </tr>
    </tbody>
  </table>
  <a id="SpiceSharp_Validation_VariablePresenceRule_Violations_" data-uid="SpiceSharp.Validation.VariablePresenceRule.Violations*"></a>
  <h4 id="SpiceSharp_Validation_VariablePresenceRule_Violations" data-uid="SpiceSharp.Validation.VariablePresenceRule.Violations">Violations</h4>
  <div class="markdown level1 summary"><p>Gets the rule violations.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="decalaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public IEnumerable&lt;IRuleViolation&gt; Violations { get; }</code></pre>
  </div>
  <h5 class="propertyValue">Property Value</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><span class="xref">System.Collections.Generic.IEnumerable</span>&lt;<a class="xref" href="SpiceSharp.Validation.IRuleViolation.html">IRuleViolation</a>&gt;</td>
        <td><p>The rule violations.</p>
</td>
      </tr>
    </tbody>
  </table>
  <h3 id="methods">Methods
  </h3>
  <a id="SpiceSharp_Validation_VariablePresenceRule_AddPath_" data-uid="SpiceSharp.Validation.VariablePresenceRule.AddPath*"></a>
  <h4 id="SpiceSharp_Validation_VariablePresenceRule_AddPath_SpiceSharp_Validation_IRuleSubject_SpiceSharp_Simulations_IVariable___" data-uid="SpiceSharp.Validation.VariablePresenceRule.AddPath(SpiceSharp.Validation.IRuleSubject,SpiceSharp.Simulations.IVariable[])">AddPath(IRuleSubject, IVariable[])</h4>
  <div class="markdown level1 summary"><p>Applies the specified variables as being connected by a conductive path.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="decalaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public void AddPath(IRuleSubject subject, params IVariable[] variables)</code></pre>
  </div>
  <h5 class="parameters">Parameters</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Name</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><a class="xref" href="SpiceSharp.Validation.IRuleSubject.html">IRuleSubject</a></td>
        <td><span class="parametername">subject</span></td>
        <td><p>The rule subject.</p>
</td>
      </tr>
      <tr>
        <td><a class="xref" href="SpiceSharp.Simulations.IVariable.html">IVariable</a>[]</td>
        <td><span class="parametername">variables</span></td>
        <td><p>The variables.</p>
</td>
      </tr>
    </tbody>
  </table>
  <a id="SpiceSharp_Validation_VariablePresenceRule_AddPath_" data-uid="SpiceSharp.Validation.VariablePresenceRule.AddPath*"></a>
  <h4 id="SpiceSharp_Validation_VariablePresenceRule_AddPath_SpiceSharp_Validation_IRuleSubject_SpiceSharp_Validation_ConductionTypes_SpiceSharp_Simulations_IVariable___" data-uid="SpiceSharp.Validation.VariablePresenceRule.AddPath(SpiceSharp.Validation.IRuleSubject,SpiceSharp.Validation.ConductionTypes,SpiceSharp.Simulations.IVariable[])">AddPath(IRuleSubject, ConductionTypes, IVariable[])</h4>
  <div class="markdown level1 summary"><p>Specifies variables as being connected by a conductive path of the specified type.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="decalaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public void AddPath(IRuleSubject subject, ConductionTypes type, params IVariable[] variables)</code></pre>
  </div>
  <h5 class="parameters">Parameters</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Name</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><a class="xref" href="SpiceSharp.Validation.IRuleSubject.html">IRuleSubject</a></td>
        <td><span class="parametername">subject</span></td>
        <td><p>The subject that applies the conductive paths.</p>
</td>
      </tr>
      <tr>
        <td><a class="xref" href="SpiceSharp.Validation.ConductionTypes.html">ConductionTypes</a></td>
        <td><span class="parametername">type</span></td>
        <td><p>The type of path between these variables.</p>
</td>
      </tr>
      <tr>
        <td><a class="xref" href="SpiceSharp.Simulations.IVariable.html">IVariable</a>[]</td>
        <td><span class="parametername">variables</span></td>
        <td><p>The variables that are connected.</p>
</td>
      </tr>
    </tbody>
  </table>
  <a id="SpiceSharp_Validation_VariablePresenceRule_Reset_" data-uid="SpiceSharp.Validation.VariablePresenceRule.Reset*"></a>
  <h4 id="SpiceSharp_Validation_VariablePresenceRule_Reset" data-uid="SpiceSharp.Validation.VariablePresenceRule.Reset">Reset()</h4>
  <div class="markdown level1 summary"><p>Resets the rule.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="decalaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public void Reset()</code></pre>
  </div>
  <h3 id="implements">Implements</h3>
  <div>
      <a class="xref" href="SpiceSharp.Validation.IConductiveRule.html">IConductiveRule</a>
  </div>
  <div>
      <a class="xref" href="SpiceSharp.Validation.IRule.html">IRule</a>
  </div>
  <h3 id="extensionmethods">Extension Methods</h3>
  <div>
      <a class="xref" href="SpiceSharp.Utility.html#SpiceSharp_Utility_ThrowIfNull__1___0_System_String_">Utility.ThrowIfNull&lt;T&gt;(T, String)</a>
  </div>
  <h3 id="seealso">See Also</h3>
  <div class="seealso">
      <div><a class="xref" href="SpiceSharp.Validation.IConductiveRule.html">IConductiveRule</a></div>
  </div>
</article>
          </div>
          
          <div class="hidden-sm col-md-2" role="complementary">
            <div class="sideaffix">
              <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
              <!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
              </nav>
            </div>
          </div>
        </div>
      </div>
      
      <footer>
        <div class="grad-bottom"></div>
        <div class="footer">
          <div class="container">
            <span class="pull-right">
              <a href="#top">Back to top</a>
            </span>
            
            <span>Generated by <strong>DocFX</strong></span>
          </div>
        </div>
      </footer>
    </div>
    
    <script type="text/javascript" src="../styles/docfx.vendor.js"></script>
    <script type="text/javascript" src="../styles/docfx.js"></script>
    <script type="text/javascript" src="../styles/main.js"></script>
  </body>
</html>
